OAI-PMH 2.0 Implementation to export Materials #1146
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oai pmh support
Oai pmh repo url fix
Merge remote changes and small OAI-PMH fixes
Merge main developments into oai-pmh branch
|
Remaining TODOs for this pull request:
|
fbacall
requested changes
Sep 10, 2025
config/environment.rb
Outdated
Comment on lines
21
to
28
| class PublicMaterial < Material | ||
| default_scope { where(visible: true) } | ||
|
|
||
| # Pretend to be a regular Material (for URLs in RDF serialization) | ||
| def self.model_name | ||
| Material.model_name | ||
| end | ||
| end |
There was a problem hiding this comment.
According to the docs, we can pass a scoped relation to OAI::Provider::ActiveRecordWrapper.new instead of needing to make a new class:
https://github.com/code4lib/ruby-oai/blob/master/lib/oai/provider.rb#L249-L253
There was a problem hiding this comment.
Good catch. Changed in 7c2a9e7.
app/models/material.rb
Outdated
Comment on lines
206
to
250
| # Dublin Core mappings for OAI-PMH | ||
| # no mapping needed for contributor, description and title | ||
| # coverage and source not mappable | ||
| alias_attribute :creators, :authors | ||
|
|
||
| def dates | ||
| [date_published, date_created, date_modified].compact.map(&:iso8601) | ||
| end | ||
|
|
||
| def format = 'text/html' | ||
|
|
||
| def identifier | ||
| if !doi.nil? && !doi.empty? | ||
| doi_iri = doi.start_with?('http://', 'https://') ? doi : "https://doi.org/#{doi}" | ||
| else | ||
| url | ||
| end | ||
| end | ||
|
|
||
| def language = 'en' | ||
|
|
||
| def publishers | ||
| if content_provider | ||
| [content_provider.title] | ||
| else | ||
| [] | ||
| end | ||
| end | ||
|
|
||
| # currently only url of tess resource, content provider url | ||
| def relations | ||
| [ | ||
| "#{TeSS::Config.base_url}#{Rails.application.routes.url_helpers.material_path(self)}" | ||
| ] + (content_provider ? [content_provider.url] : []) | ||
| end | ||
|
|
||
| alias_attribute :rights, :licence | ||
|
|
||
| def subjects | ||
| keywords + scientific_topics.map(&:uri) + operations.map(&:uri) | ||
| end | ||
|
|
||
| def types | ||
| ['http://purl.org/dc/dcmitype/Text', 'https://schema.org/LearningResource'] + resource_type | ||
| end |
There was a problem hiding this comment.
I think it would be cleaner if we could move these methods into another class if that's possible
There was a problem hiding this comment.
Moved to one method in 8b54db2.
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
fbacall
reviewed
Oct 15, 2025
Comment on lines
+194
to
+204
| def to_rdf | ||
| jsonld_str = to_bioschemas[0].to_json | ||
|
|
||
| graph = RDF::Graph.new | ||
| JSON::LD::Reader.new(jsonld_str) do |reader| | ||
| reader.each_statement { |stmt| graph << stmt } | ||
| end | ||
|
|
||
| rdfxml_str = graph.dump(:rdfxml, prefixes: { sdo: 'http://schema.org/', dc: 'http://purl.org/dc/terms/' }) | ||
| rdfxml_str.sub(/\A<\?xml.*?\?>\s*/, '') # remove XML declaration because this is used inside OAI-PMH response | ||
| end |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of changes
/oai-pmhthat allows harvesting of visible training materials in Dublin Core and RDF (Bioschemas) metadata standardMotivation and context
This is a relevant step in the mTeSS-X project.
Screenshots
Checklist
to license it to the TeSS codebase under the
BSD license.